#ifndef OMG_TDDS_SUB_READ_CONDITION_HPP_
#define OMG_TDDS_SUB_READ_CONDITION_HPP_

/* Copyright (c) 2009-2010, Real-Time Innovations, Inc.
 * Copyright (c) 2010, Object Management Group, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - Neither the names of the above copyright holders nor the names of their
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL A COPYRIGHT HOLDER OR CONTRIBUTOR BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */


namespace tdds { namespace sub {


/**
 * ReadCondition objects are conditions specifically dedicated
 * to read operations and attached to one DataReader.
 * <br>
 * ReadCondition objects allow an application to specify the data samples
 * it is interested in (by specifying the desired sample states, view states,
 * and instance states). See the parameter definitions for DataReader's
 * read/take operations.) This allows the middleware to enable the condition
 * only when suitable information is available. They are to be used in
 * conjunction with a WaitSet as normal conditions. More than one
 * ReadCondition may be attached to the same DataReader.
 */
template <typename DELEGATE>
class ReadConditionBase : public tdds::core::Condition<DELEGATE> {
    OMG_DDS_REFERENCE_TYPE(ReadConditionBase)

public:
    /**
     * This operation returns the set of sample-states that are taken into
     * account to determine the trigger_value of the ReadCondition. These are
     * the sample-states specified when the ReadCondition was created.
     */
    const dds::core::status::SampleState sample_state_mask() const;

    /**
     * This operation returns the set of view-states that are taken into
     * account to determine the trigger_value of the ReadCondition.
     * These are the view-states specified when the ReadCondition was created.
     */
    const dds::core::status::ViewState view_state_mask() const;

    /**
     * This operation returns the set of instance-states that are taken into
     * account to determine the trigger_value of the ReadCondition. These are
     * the instance-states specified when the ReadCondition was created.
     */
    const dds::core::status::InstanceState instance_state_mask() const;

    void close();
};
} }

#endif /* OMG_TDDS_SUB_READ_CONDITION_HPP_ */


